home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / gt_power / fbbs317.zip / FIXBBS.DOC next >
Text File  |  1990-04-23  |  16KB  |  412 lines
  1.  
  2.  
  3.            FIXBBS - a FILES.BBS maintenance utility for GT Sysops
  4.  
  5.  
  6.            Revision history
  7.  
  8.         22/4/90  - v3.17 - minor bugfix for SETFBBS
  9.  
  10.         20/4/90  - v3.16 - add "word highlight"
  11.                          - fix minor display bugs
  12.                          - fix new files problem
  13.                          - fix descr problem
  14.  
  15.         20/4/90  - v3.15 - fix comment bug
  16.                          - fix "word wrap"
  17.                          - add timeout date select
  18.                          - add offline total option
  19.                          - fix directory check
  20.                          - add multiline descriptions on prompt
  21.  
  22.            v3.10 11/4/90  - Add colours for NEW files
  23.                           - add "timeout" for New files
  24.                           - fix date bug(s)
  25.                           - add OFFLINE option
  26.                           - fix various minor nasties
  27.                           - add more colour options
  28.                           - fix space check bug
  29.                           - made comment char configurable
  30.  
  31.            v3.02 24/3/90  - cater for new FILES.BBS format
  32.                           - add color to menus
  33.                           - seperate configuration program
  34.                           - add Total Files: line
  35.                           - improved menus
  36.                           - add /N parameter
  37.                           - Fix bugs in v3.00
  38.  
  39.            v2.01 24/12/89 - Cosmetic fix
  40.                           - Fix command stack bug with < 20 file areas
  41.  
  42.            v2.00 13/12/89 - Add sort overrides
  43.                           - Add Dest change on "process"
  44.                           - Modify GTDIR parsing
  45.                           - add area # to heading
  46.                           - fix multiple listing bug
  47.                           - add "validate after edit option"
  48.                           - add SHELL to DOS
  49.                           - increase NEW files
  50.                           - add file # stacking
  51.  
  52.            v1.92 12/11/89 - Fix bug in BATCH mode if bulletins
  53.                             ignored
  54.  
  55.            v1.90  5/11/89 - Add command stacking
  56.                           - Add "ignore bulletins"
  57.  
  58.            v1.80  1/11/89 - Rewrite validate for speed increse
  59.                           - Minor cosmetic bugfix
  60.                           - Add /A parameter
  61.  
  62.            v1.72 22/10/89 - Add check for destination room
  63.                           - Add check for NO FILES.BBS
  64.                           - Add L)ist command
  65.                           - Add support for 4DOS
  66.  
  67.            v1.71 21/10/89 - Add command aliases
  68.                           - Add selection at pause line
  69.                           - Add subdirectory verification
  70.                           - Add interactive "mark offline" prompt
  71.  
  72.            v1.60 18/10/89 - first NON-BETA release
  73.            v1.00-v1.50    - BETA test code
  74.  
  75.  
  76.                           WHAT DOES IT DO?
  77.  
  78.    This program is for maintenance of your files.bbs and cbs
  79.  
  80.    some features -
  81.  
  82.   1) automatically creates files.cbs when validating the .bbs
  83.  
  84.   2) picks up the REAL file date and time during validation
  85.  
  86.   3) allows you to break a files.bbs into "sub-groups" and sorts within
  87.      sub-group.
  88.  
  89.      A "sub- group" is defined as a series of filenames between 2 comment
  90.      entries or between a comment entry and the end of the file
  91.  
  92.      A comment entry is an empty line OR a line with a space in column 1
  93.      and NOT a multi-line comment (see multi-line comments).
  94.  
  95.   4) batch mode operation - no need for macro commands - simply put a /B
  96.      on the command line and FIXBBS will validate ALL the areas defined in
  97.      your GTDIR.BBS (or the list of files you designate).
  98.  
  99.   5) If a new file (not in the files.bbs) is found FIXBBS will, if in
  100.      interactive mode, prompt for a file description. If in batch mode
  101.      it will supply a default description of "No description entered at
  102.      upload". The upload date will be set to the current date
  103.  
  104.   6) if you have a special "key line" in your files.bbs FIXBBS will insert
  105.      all NEW files (those moved/copied to the area or those NOT in the
  106.      files.bbs when validating) to a position after the "key line".
  107.  
  108.      The key line has the following format -
  109.      " New files at"
  110.       followed by TWO blank lines.
  111.  
  112.       *NOTE* - the "N" of new MUST start in column 2!!!!
  113.  
  114.       FIXBBS will append the current date to the key line and insert all
  115.       new file descriptions after it (the insert is actually done
  116.       between the two blank lines).
  117.  
  118.   7) sort files by DATE or FILENAME in either ascending or descending
  119.      order
  120.  
  121.   8) optionally forces the current date into moved/copied files
  122.  
  123.   9) optionally adds an archive comment to moved/copied ZIP, ARC, or PAK
  124.      files
  125.  
  126.   10) FIXBBS allows you to have MULTIPLE LINE COMMENTS on any file.
  127.  
  128.   11) If you are using the 4DOS command shell, FIXBBS will optionally
  129.       generate the DESCRIPT.ION hidden file that contains the
  130.       descriptions displayed by the 4DOS dir command using the
  131.       decriptions in the FILES.BBS
  132.  
  133.   12) FIXBBS can be configured to IGNORE your system bulletins in the
  134.       DEFAULT directory.
  135.  
  136.   13) If you have "     Total Files:" in columns 1-17 of ANY line in
  137.       your FILES.BBS this will be replaced by the TOTAL number of files
  138.       and total size of files in the area (exculding files.bbs etc).
  139.  
  140.       *NOTE* the format of this line is CRITICAL - columns 1-5 MUST be
  141.       spaces, ONLY the initial letters can be uppercase and there MUST
  142.       be a colon at the end!!!
  143.  
  144.   14) In v3.10 (and later) there is a NEW "key line" -
  145.  
  146.       " Files older than xx days"
  147.  
  148.       Again the format is CRITICAL - the "F" *MUST* start in Col 2. and
  149.       there must be TWO blank lines after it to denote the "sub-group".
  150.  
  151.       When a NEW file is older than the number of days specified in the
  152.       configuration it will be moved to between the 2 blank lines.
  153.  
  154.       If this line is NOT specified FIXBBS will append these "expired"
  155.       files to the LAST "sub-group" in the FILES.BBS
  156.  
  157.   15) if you add a list of words to the end of  your FIXBBS.CFG
  158.       and one of them is found in a file description it will be highlighted.
  159.  
  160.       The words are NOT case-sensitive.
  161.  
  162.       *NOTE* this feature works on WHOLE words ONLY!!!
  163.       e.g. putting "cat" the FIXBBS.CFG will ONLY match with "CAT" not
  164.       "catalog" or any word which contains the FIXBBS.CFG word
  165.  
  166.  
  167.                        PROGRAM REQUIREMENTS
  168.  
  169.   FIXBBS is BIG!! - you will probably need at LEAST 300k to run it.
  170.   This is mainly due to the fact that it calls the various archive
  171.   programs (PAK, ZIP, ARC) and your choice of editor.
  172.  
  173.   You will also need to have your GTPATH set and a valid GTDIR.BBS in
  174.   the GTPATH directory.
  175.  
  176.   All archive programs, and your editor, must be in the DOS path.
  177.  
  178.   FIXBBS will create a FIXBBS.CFG in your GTPATH - DO NOT alter this
  179.   file!
  180.  
  181. ********************  W A R N I N G   W A R N I N G  *******************
  182.  
  183.  
  184.    DO NOT USE *ANY* OTHER PROGRAM TO VALIDATE YOUR FILES.BBS AFTER USING
  185.    THIS PROGRAM!!
  186.  
  187.    DOING SO WILL DESTROY *ALL* YOUR HARD WORK AS OTHER PROGRAMS WILL NOT
  188.    RECOGNISE THE FORMATTING CONVENTIONS USED BY FIXBBS AND WILL REMOVE
  189.    COMMENT LINES ETC.
  190.  
  191.  
  192.                         PROGRAM LIMITATIONS
  193.  
  194.   There are some INBUILT limitations to FIXBBS. These are -
  195.  
  196.             maximum of 800 lines per FILES.BBS
  197.             maximum of 800 files per move/copy/erase operation
  198.             maximum of 200 file areas
  199.  
  200.  *NOTE* - the figures quoted above are MAXIMUMS!! - depending on how
  201.  long your file descriptions, comments etc. are you may NOT be able to
  202.  get the 800 line figure.
  203.  
  204.  
  205.  **NOTE** - If you are using DOS4.xx the "Check Diskspace on Move"
  206.             option may not work!
  207.                       COMMAND-LINE PARAMETERS
  208.  
  209.   FIXBBS has THREE optional command-line parameters (REGISTERED users only)
  210.  
  211.             /B - Batch mode.
  212.  
  213.                  If FIXBBS is run with this parameter it will validate
  214.                  ALL file areas as defined in your list of file areas
  215.                  (normally the GTDIR.BBS).
  216.  
  217.             /Axxxxxxxx.yyy - use a different list for the file areas.
  218.  
  219.                  If this parameter is used FIXBBS will use the file
  220.                  named xxxxxxxx.yyy as the list of files it will work
  221.                  with. The file must be in the same format as the
  222.                  GTMDIR.BBS (that is contain a list of drive\pathnames)
  223.                  and must be located in the GTPATH.
  224.                  If not specified the list defaults to the GTDIR.BBS.
  225.  
  226.  
  227.             /N - no CBS creation
  228.  
  229.                  If specified NO FILES.CBS file will be created/updated
  230.  
  231.                             RUNNING FIXBBS
  232.  
  233.   The program is fairly self-explanatory but a few aspects of operation
  234.   need to be elaborated on.
  235.  
  236.             MENU SELECTION.
  237.  
  238.             At the Main Menu and the Move sub-menu you may use either
  239.             the number or first letter of the selection you desire.
  240.  
  241.             Note that "Q" and "X" are internal aliases for "R".
  242.  
  243.             COMMAND STACKING.
  244.  
  245.             For safety purposes MOST commands are NOT stackable - this
  246.             is to prevent accidental erasure/moving of files. However,
  247.             there are FIVE commands that MAY be stacked -
  248.  
  249.                     1) you can stack an area number after the
  250.                        C)hange Area command
  251.  
  252.                     2) you can stack an area number after the
  253.                        S)ource Area selection command
  254.  
  255.                     3) similarly you can stack an area number after the
  256.                        D)estination Area command
  257.  
  258.                     4) you can  stack a line number after the
  259.                        L)ist area - the listing will start from the
  260.                        specified line.
  261.  
  262.                     5) a SERIES of file numbers may be stacked in the
  263.                        move/copy/erase command. Numbers are separated by
  264.                        any NON-numeric character, with the exception of
  265.                        the "-" character which is used to designate a
  266.                        range of numbers to mark/unmark.
  267.  
  268.                        e.g.
  269.  
  270.                        5,7,8,11-15 would mark files 5 7 8 11 12 13 14 15
  271.  
  272.                        Overlapping ranges WILL cause strange effects
  273.  
  274.                        e.g.
  275.  
  276.                        1-4 3-7 will NOT mark files 1 2 3 4 5 6 7
  277.                        but will mark files 1 2 5 6 7!!
  278.  
  279.                        The reason for this is that the 1-4 DOES mark
  280.                        files 1 2 3 4 but the 3-7 toggles files 3 4 and
  281.                        marks files 5 6 and 7.
  282.  
  283.                        (remember the the mark/unmark is a toggle - if
  284.                        you mark a file TWICE the second mark negates the
  285.                        first)
  286.  
  287.             If an out of range value is specified it will be ignored.
  288.  
  289.  
  290.             ARCHIVE COMMENT. (REGISTERED users only)
  291.  
  292.             The Archive comment will be added to ANY ZIP, ARC, or PAK
  293.             file that is moved to another area.
  294.  
  295.             If the FIRST TWO characters of the archive comment are
  296.             "=F" (no quotes and uppercase F) the characters following the
  297.             =F are treated as the Drive\path\filename.ext of a file that
  298.             contains the archive comment.
  299.  
  300.             EDITOR NAME.
  301.  
  302.             This entry defines the NAME of the editor you wish to use
  303.             for your FILES.BBS. *NOTE* your editor MUST be capable of
  304.             accepting the filename to be edited as a command-line
  305.             parameter.
  306.  
  307.             FIXBBS will automatically create a FILES.CBS when
  308.             you exit from the edit function. Also, if required, FIXBBS
  309.             will validate the area.
  310.  
  311.             NEW FILES. (REGISTERED users only)
  312.  
  313.             If a special keyline is included in your FILES.BBS FIXBBS
  314.             will handle all NEW files (those currently not in the
  315.             FILES.BBS) in a special way -
  316.  
  317.             FIXBBS will append your REGISTERED NAME and the current date to
  318.             the key line and insert all new file descriptions after it.
  319.  
  320.             The key line has the following format -
  321.             " New files at"
  322.             followed by TWO blank lines.
  323.  
  324.             *NOTE* - the "N" of new MUST start in column 2!!!!
  325.  
  326.              The TWO blank lines are used to define a SUB-GROUP within
  327.              the FILES.BBS.
  328.  
  329.              To convert a NEW file entry to a normal entry simply move
  330.              it to the appropriate area somewhere else in your FILES.BBS
  331.              with the Edit function.
  332.  
  333.              MULTI-LINE COMMENTS. (REGISTERED users only)
  334.  
  335.              Any file may now have more than one comment line associated
  336.              with it. These multi-line comments are identified by the
  337.              presence of a period (.) in column 26 of the FILES.BBS.
  338.  
  339.              All lines with a period are "glued" to the preceding file
  340.              entry (which must NOT have a continuation mark!). A
  341.              multi-line file may be manipulated (moved/copied/deleted)
  342.              by FIXBBS as if it were a single entry.
  343.  
  344.              *NOTE* this "gluing" does NOT apply to EDITING a FILES.BBS
  345.              - use the "block move" command of your editor to accomplish this.
  346.  
  347.              OFFLINE FILES.
  348.  
  349.              If an asterisk (*) is placed in column 26 of the FILES.BBS
  350.              no check is made for the presence of the file in the
  351.              directory.
  352.  
  353.              IGNORE BULLETINS.
  354.  
  355.              If the "ignore bulletins" mode is selected in the
  356.              configuration FIXBBS will NOT check for the presence of the
  357.              system bulletins in the FILES.BBS.
  358.  
  359.              A system bulletin is defined as a file with a file name of
  360.              1 through 99 and either NO extension or an extension of
  361.              .CBS.
  362.  
  363.              *NOTE* if IGNORE mode is used and there ARE existing
  364.              descriptions in the FILES.BBS FIXBBS will NOT remove the
  365.              description - this will have to be done manually, but no
  366.              NEW descriptions will be generated.
  367.  
  368.  
  369.              VALIDATE AFTER EDIT.
  370.  
  371.              Normally FIXBBS will NOT validate a FILES.BBS that you have
  372.              edited but merely re-writes the FILES.BBS/CBS.
  373.              You can, however, elect to have FULL validation performed
  374.              after an edit (as a safety measure).
  375.  
  376.                                 REGISTRATION.
  377.  
  378.             This program MUST be registered to be fully operational.
  379.             Batch mode, multi-line comments, new file maintenance,
  380.             alternate area lists, and archive commenting are disabled
  381.             in unregistered copies.
  382.  
  383.             Please read the enclosed README.NOW file for registration
  384.             information.
  385.  
  386.  
  387.                          FURTHER INFORMATION.
  388.  
  389.                 May be obtained from the author -
  390.  
  391.                            Ken Thompson
  392.                            164 Lyons Rd.
  393.                           Drummoyne N.S.W.
  394.                        Sydney Australia 2047
  395.  
  396.                           +61-2-81-4751
  397.  
  398.                  or I may be contacted via my BBS
  399.  
  400.  
  401.                          The Black Hole
  402.                       GT Net/Node 302/003
  403.  
  404.              Modem  +61-2-719-8161 (9600 CRASH!able)
  405.              Modem  +61-2-819-6971 (2400 NO CRASH!mail)
  406.              Modem  +61-2-719-8491 (2400 NO CRASH!mail)
  407.  
  408.  
  409.  
  410.  
  411.  
  412.